CIMPLICITY REST API Web Service
CIMPLICITY REST API Web Service / All Operations Resource Group / /projects/{projectId}/users (Get)
In This Topic
    Get/projects/{projectId}/users
    In This Topic
    Description
    returns a list of users in a project that satisfy the filter criteria
    Parameters
    NameDescriptionData Type
    projectIdthe id of the project to look instring
    skipnumber of records to skip for paginationinteger (int32)
    limitmaximum number of records to returninteger (int32)
    UserIDprovides a wild card string to filter users by their UserID.string
    RoleIDprovides a wild card string to filter users using their corresponding RoleID.string
    200 Response

    The response body is of type UsersGetResponse.

    The collection of users that satisfy the query.

    Overview

    UsersGetResponse
    The results of the users get query.
    Users : Array[CimUser]
    An array of the users that satify the query criteria.
    AuthenticationType : CimUserType
    Enable : boolean
    set it to true to enable the user.
    PasswordExpiresInDays : number
    password expires in number of configured days.
    Password : string
    Password for the user.
    Resources : Array[string]
    An array of resources that mapped to the user.
    RoleID : string
    The Id of role.
    UserID : string
    The Id of user.
    UserName : string
    The name of user.
    Fault Responses
    FaultDescription
    404This fault returns a response body of type ProblemDetails.
    project with the given id is not registered on the system
    See Also
    All Operations Resource Group | CIMPLICITY REST API Web Service

     

     

    © 2021 All Rights Reserved.